ChartIQ SDK/com.chartiq.sdk.model.study

Package-level declarations

This package contains all classes to work with Studies¬.

Types

data class Study(val name: String, val attributes: Map<String, Any>?, val centerLine: Double, val customRemoval: Boolean, val deferUpdate: Boolean, val display: String?, var inputs: Map<String, Any>?, var outputs: Map<String, Any>?, val overlay: Boolean, var parameters: Map<String, Any>, val range: String?, val shortName: String, val type: String?, val underlay: Boolean, val yAxis: Map<String, Any>?, val signalIQExclude: Boolean) : Parcelable

Encapsulates parameters with additional information for Study. ChartIQ uses the term “study” to refer to any indicator, oscillator, average, or signal that results from technical analysis of chart data.

StudyEntity

data class StudyEntity(val attributes: Map<String, Object>?, val centerLine: Double, val customRemoval: Boolean, val deferUpdate: Boolean, val display: String?, var parsed_inputs: List<Map<String, Object>>?, var parsed_outputs: List<Map<String, Object>>?, val name: String, val overlay: Boolean, var parameters: Map<String, Object>?, val range: String?, val shortName: String?, val type: String?, val underlay: Boolean, val yAxis: Map<String, Object>?, val signalIQExclude: Boolean) : Serializable

StudyParameter

sealed class StudyParameter : Parcelable

A base class of active study parameter

StudyParameterModel

data class StudyParameterModel(val fieldName: String, val fieldSelectedValue: String)

A model to change a parameter in active study Study

StudyParameterType

enum StudyParameterType : Enum<StudyParameterType>

A possible study parameter types

StudySimplified

data class StudySimplified(val studyName: String, var outputs: Map<String, Any>?, val type: String?) : Parcelable

StudySimplifiedEntity

data class StudySimplifiedEntity(val studyName: String, var parsed_outputs: List<Map<String, Object>>?, val type: String?)

Functions

toStudySimplified

fun StudySimplifiedEntity.toStudySimplified(): StudySimplified